Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[docs-only] add toc to changelog #4210

Merged
merged 1 commit into from
Nov 9, 2023
Merged

[docs-only] add toc to changelog #4210

merged 1 commit into from
Nov 9, 2023

Conversation

mmattel
Copy link
Contributor

@mmattel mmattel commented Nov 9, 2023

Description

Adds table of contents to the top of the CHANGELOG.md file.

Anchor links in markdown are generated from the content of the header according to the following rules:

  1. All text is converted to lowercase.
  2. All non-word text (e.g., punctuation, HTML) is removed.
  3. All spaces are converted to hyphens.
  4. Two or more hyphens in a row are converted to one.
  5. If a header with the same ID has already been generated, a unique incrementing number is appended, starting at 1.
  6. All changelogs for 2.x and below have a main entrance link

Related Issue

Related Issues

App:

  • Added changelog files for the fixed issues in folder changelog/unreleased. More info here

QA

@jesmrec
Copy link
Collaborator

jesmrec commented Nov 9, 2023

How do this affect Calens?

@JuancaG05 JuancaG05 removed the request for review from abelgardep November 9, 2023 13:58
@mmattel
Copy link
Contributor Author

mmattel commented Nov 9, 2023

Run locally, works nicely 😄
image

@mmattel mmattel requested a review from jesmrec November 9, 2023 15:09
@mmattel
Copy link
Contributor Author

mmattel commented Nov 9, 2023 •
edited
Loading

How do this affect Calens?

We add in all products where we publish changelogs a table of contents. This makes it much easier to read. In addition, the changelog is pulled automatically to our homepage into the changelog section and also shown there, now with a greatly improved readbility.

@michaelstingl

This comment was marked as resolved.

Sign in to view
@michaelstingl
Copy link
Contributor

michaelstingl commented Nov 9, 2023 •
edited
Loading

2.18.0 to 2.20.0 not included?

Also include the earlier versions?

curl -s "https://raw.githubusercontent.com/owncloud/android/master/CHANGELOG.md" | grep -e "Changelog for" -e "## " | grep -v " beta "
Changelog for ownCloud Android Client [unreleased] (UNRELEASED)
Changelog for ownCloud Android Client [4.1.1] (2023-10-18)
Changelog for ownCloud Android Client [4.1.0] (2023-08-23)
Changelog for ownCloud Android Client [4.0.0] (2023-05-29)
Changelog for ownCloud Android Client [3.0.4] (2023-03-07)
Changelog for ownCloud Android Client [3.0.3] (2023-02-13)
Changelog for ownCloud Android Client [3.0.2] (2023-01-26)
Changelog for ownCloud Android Client [3.0.1] (2022-12-21)
Changelog for ownCloud Android Client [3.0.0] (2022-12-12)
Changelog for ownCloud Android Client [2.21.2] (2022-09-07)
Changelog for ownCloud Android Client [2.21.1] (2022-06-15)
Changelog for ownCloud Android Client [2.21.0] (2022-06-07)
Changelog for ownCloud Android Client [2.20.0] (2022-02-16)
Changelog for ownCloud Android Client [2.19.0] (2021-11-15)
Changelog for ownCloud Android Client [2.18.3] (2021-10-27)
Changelog for ownCloud Android Client [2.18.1] (2021-07-20)
Changelog for ownCloud Android Client [2.18.0] (2021-05-24)
## 2.17 (March 2021)
## 2.16.0 (January 2021)
## 2.15.3 (October 2020)
## 2.15.2 (September 2020)
## 2.15.1 (July 2020)
## 2.15 (June 2020)
## 2.14.2 (January 2020)
## 2.14.1 (December 2019)
## 2.14 (December 2019)
## 2.13.1 (October 2019)
## 2.13 (September 2019)
## 2.12 (August 2019)
## 2.11.1 (June 2019)
## 2.11 (June 2019)
## 2.10.1 (April 2019)
## 2.10.0 (March 2019)
## 2.9.3 (November 2018)
## 2.9.2 (November 2018)
## 2.9.1 (November 2018)
## 2.9.0 (November 2018)
## 2.8.0 (July 2018)
## 2.7.0 (April 2018)
## 2.6.0 (February 2018)
## 2.5.0 (October 2017)
## 2.4.0 (May 2017)
## 2.3.0 (March 2017)
## 2.2.0 (December 2016)
## 2.1.1 (September 2016)
## 2.1.0 (August 2016)
## 2.0.1 (June 2016)
## 2.0.0 (April 2016)
## 1.9.1 (February 2016)
## 1.9.0 (December 2015)
## 1.8.0 (September 2015)
## 1.7.2 (July 2015)
## 1.7.1 (April 2015)
## 1.7.0 (February 2015)

@mmattel
Copy link
Contributor Author

mmattel commented Nov 9, 2023

Also include the earlier versions...

See: owncloud/ios-app#1287 (comment)

@michaelstingl michaelstingl merged commit de8c475 into master Nov 9, 2023
4 checks passed
@michaelstingl michaelstingl deleted the mmattel-patch-1 branch November 9, 2023 17:35
Aitorbp pushed a commit that referenced this pull request Feb 5, 2024
@mmattel @Aitorbp
[docs-only] add toc to changelog (#4210)
850f9eb
Aitorbp pushed a commit that referenced this pull request Feb 13, 2024
@mmattel @Aitorbp
[docs-only] add toc to changelog (#4210)
205d1b5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@michaelstingl michaelstingl michaelstingl approved these changes

@jesmrec jesmrec Awaiting requested review from jesmrec

@JuancaG05 JuancaG05 Awaiting requested review from JuancaG05

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mmattel @jesmrec @michaelstingl